Vcenter Namespaces Instances SetSpec

Vcenter Namespaces Instances SetSpec
Vcenter Namespaces Instances SetSpec

The Vcenter Namespaces Instances SetSpec schema contains the specification required to set a new configuration on the namespace. This schema is applied in entirety, replacing the current specification fully.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "description": "string",
    "resource_spec": {},
    "access_list": [
        {
            "subject_type": "string",
            "subject": "string",
            "domain": "string",
            "role": "string",
            "identity_provider": "string"
        }
    ],
    "storage_specs": [
        {
            "policy": "string",
            "limit": 0
        }
    ],
    "vm_service_spec": {
        "content_libraries": [
            "string"
        ],
        "vm_classes": [
            "string"
        ]
    },
    "content_libraries": [
        {
            "content_library": "string",
            "writable": false,
            "allow_import": false,
            "resource_naming_strategy": "string"
        }
    ],
    "network_spec": {
        "network_provider": "string",
        "vpc_config": {
            "default_subnet_size": 0,
            "private_cidrs": [
                {
                    "address": "string",
                    "prefix": 0
                }
            ]
        }
    }
}
string
description
Optional

Description for the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, the description of the namespace will be cleared.

object
resource_spec
Optional

Resource quota for the namespace. This will replace the existing resource constraints on the namespace in entirety. Refer to Vcenter NamespaceManagement NamespaceResourceOptions Info.create_resource_quota_type and use GET /vcenter/namespace-management/clusters/{cluster}/workload-resource-options for retrieving the type for the value for this field. For an example of this, see Vcenter Namespaces ResourceQuotaOptionsV1.

This property was added in vSphere API 7.0.0.0.

If missing or null, the resource constraints on the namespace will be cleared.

access_list
Optional

Access control associated with the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, the existing access controls on the namespace will be removed and users will not be able to access this namespace to create new pods. Existing pods from users will continue to run.

storage_specs
Optional

Storage associated with the namespace.

This property was added in vSphere API 7.0.0.0.

If missing or null, the existing storage policies will be disassociated with the namespace and existing limits will be cleared. Pods which are already using persistent storage from the earlier version of storage policies will be able to access them till the datastores are attached to the worker nodes.

vm_service_spec
Optional

VM Service specification associated with the namespace.

This property was added in vSphere API 7.0.2.00100.

This property is optional because it was added in a newer version than its parent node.

content_libraries
Optional

List of Content Libraries used by the VM Image Service. This list refers to existing Content Libraries in vSphere inventory.

The Content Libraries specified in {VMServiceSpec#contentLibraries} will also be included in this list but will be read-only by default to users.

If the same Content Library is present both here and in {VMServiceSpec#contentLibraries}, then:

  • The Content Library is only surfaced to users once.
  • The settings here are honored.

This property was added in vSphere API 8.0.2.0.

If missing or null, the existing Content Libraries configured for the VM Image Service will be removed.

network_spec
Optional

Network related configurations to be set with this namespace.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.